Member functions

class PortalClient(servicePath[, clientGUID, autoCreateSession=true])
Arguments:
  • name (string) – URL of the CHAOS Portal service
  • clientGUID (string) – A GUID identifying this client service
  • autoCreateSession (bool) – Create session automatically

The class of the Javascript client through which all communication with CHAOS Portal goes.

PortalClient.Folder_Get(callback, id, folderTypeID, parentID)
Arguments:
  • callback (function(serviceResult)) – Function to be called with serviceResult.
  • id (int) – Folder ID
PortalClient.Object_Get(callback, query, sort, accessPointGUID, pageIndex, pageSize[, includeMetadata, includeFiles, includeObjectRelations, includeAccessPoints])
Arguments:
  • callback (function(serviceResult)) – Function to be called with serviceResult.
  • query (string) – Solr query to get objects by
  • sort (bool) – Can be null
  • accessPointGUID (string) – GUID identifying the accessPoint and thus authenticating the call
  • pageIndex (int) – Which page to get in pagination
  • pageSize (int) – Size of each page in pagination

CHAOS paginates all result so you need to specify a page size (pageSize) and a page index (pageIndex) that specifies which page of objects should be returned.

PortalClient.Object_GetBySearch(callback, searchString, schemas, langCode, sort, accessPointGUID, pageIndex, pageSize[, includeMetadata, includeFiles, includeObjectRelations, includeAccessPoints])
Arguments:
  • callback (function(serviceResult)) – Function to be called with serviceResult.
  • searchString (string) – Solr query to get objects by
  • schemas (string|array) – A string or an array of strings of the schemas to be searched
  • langCode (string) – The language code that should be used for search, e.g. da_dk, en_us
  • sort (bool) – Can be null
  • accessPointGUID (string) – GUID identifying the accessPoint thereby authenticating the call
  • pageIndex (int) – Which page to get in pagination
  • pageSize (int) – Size of each page in pagination